/*
 * Copyright (c) 2013, SRI International
 * All rights reserved.
 * Licensed under the The BSD 3-Clause License;
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at:
 * 
 * http://opensource.org/licenses/BSD-3-Clause
 * 
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 
 * Redistributions of source code must retain the above copyright
 * notice, this list of conditions and the following disclaimer.
 * 
 * Redistributions in binary form must reproduce the above copyright
 * notice, this list of conditions and the following disclaimer in the
 * documentation and/or other materials provided with the distribution.
 * 
 * Neither the name of the aic-web-praise nor the names of its
 * contributors may be used to endorse or promote products derived from
 * this software without specific prior written permission.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
 * COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, 
 * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES 
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, 
 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
 * OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package com.sri.ai.lpitools.executionengine.interfaces.api;

import com.sri.ai.lpitools.cobra.gwtutil.dataobjects.shared.LWPException;

public interface ExecutionEngineInterface {

	/**
	 * Checks if the passed in model is valid
	 * @param user
	 * @param model
	 * @return
	 */
	public boolean checkModelByModel(String model) throws LWPException;
	
	/**
	 * Takes the Query and runs it against Model and returns result
	 * @param user
	 * @param modelTitle
	 * @param query
	 * @param clientID
	 * @param QueryOptionsJSON -- serialized JSON representation of QueryOptions
	 * @param url 
	 * @return
	 * @throws Exception 
	 * @throws XmlRpcException 
	 */
	public String runQuery(String user, String model, String evidenceTitle, String query, String clientID, String QueryOptionsJSON, String url) throws LWPException;
	
	
	/**
	 * Returns a Unique ID to the calling client as a String
	 * @return
	 */
	public String getID() throws LWPException;
	
	
	/**
	 * This function is used to set up the Execution Engine Client
	 * @param url
	 */
	public void setUp(String url);
}
